Aller au contenu principal

Déplacer un fichier ou un répertoire (file.move)

Déclaration​

succès, message d’erreur = file.move(chemin source, chemin cible [, mode])

Paramètres​

  • chemin source
    Chaîne, chemin absolu du fichier ou du répertoire source
  • chemin cible
    Chaîne, chemin absolu complet du fichier ou du répertoire après déplacement, comprenant le nom du fichier ou du répertoire cible
  • mode 20250914+
    Chaîne, paramètre facultatif, mode de déplacement. Valeurs possibles :
    • chaîne vide ou omis : mode par défaut (no-clobber), renvoie un échec si la cible existe déjà
    • "overwrite" ou "o" : mode de remplacement, remplace directement la cible existante (la cible existante est supprimée)
    • "merge" ou "m" : mode de fusion (uniquement pour les répertoires), conserve les fichiers déjà présents dans la cible
    • "overwrite-merge" ou "om"/"mo" : mode de fusion avec remplacement, fusionne les répertoires mais remplace les fichiers de même nom

Valeur de retour​

  • succès
    Booléen, renvoie true si l’opération réussit et false dans le cas contraire
  • message d’erreur
    Chaîne, message d’erreur en cas d’échec

Description​

Déplace le fichier ou le répertoire désigné par chemin source vers le chemin exact chemin cible ; changer le nom dans le même répertoire constitue un renommage.
Cette fonction signifie « déplacer sous », et non « déplacer dans ». chemin cible désigne le fichier ou le répertoire final ; le nom du fichier ou du répertoire source n’est pas ajouté automatiquement. Même si la cible est un répertoire existant ou si son chemin se termine par /, la source n’est pas placée à l’intérieur de ce répertoire.
Par exemple, pour déplacer /a/b/c dans /d/e/ en conservant le nom c, le chemin cible doit être /d/e/c, et non simplement /d/e/.
Si la cible existe déjà, le paramètre mode détermine le comportement : le mode par défaut renvoie un échec, le mode de remplacement remplace la cible elle-même, et les modes de fusion de répertoires fusionnent le contenu du répertoire source dans le répertoire cible.
Mots-clés : renommer un fichier, renommer un répertoire, renommer un dossier, déplacer un fichier, déplacer un répertoire, déplacer un dossier
Cette fonction est disponible dans les versions postérieures à 20250313

Exemple​

ok, err = file.move(XXT_SCRIPTS_PATH..'/1.zip', XXT_SCRIPTS_PATH..'/2.zip')
if not ok then
sys.alert('Échec du déplacement : '..err)
end

Remarque : le code ci-dessus utilise la fonction hors de ce chapitre sys.alert

Déplacer dans un autre répertoire en conservant le nom​

-- Supposons que /d/e soit un répertoire existant et que /d/e/c n’existe pas encore
file.move('/a/b/c', '/d/e/c') -- Correct : déplacer c vers /d/e/c

-- Exemple incorrect indépendant : la cible est e lui-même, pas c dans le répertoire e
-- file.move('/a/b/c', '/d/e/') -- Échoue en mode par défaut, car la cible existe déjà

-- Le mode de remplacement remplace e lui-même et ne crée pas /d/e/c (20250914+)
-- file.move('/a/b/c', '/d/e/', 'overwrite')

Définir une fonction pour déplacer dans un répertoire​

L’exemple suivant définit une fonction auxiliaire personnalisée et nécessite une version postérieure à 20250914. Le répertoire cible doit déjà exister. La fonction conserve le nom du fichier ou du répertoire source et transmet le paramètre facultatif mode à file.move. Les conflits de noms restent traités selon le mode indiqué.

local function file_move_into(src_path, dst_dir, mode)
if file.exists(dst_dir) ~= "directory" then
return false, "Target is not a directory"
end

local name, err = file.path.last_component(src_path)
if not name then
return false, err
end
-- Évite de prendre le répertoire cible lui-même ou son parent comme cible finale.
if name == "" or name == "/" or name == "." or name == ".." then
return false, "Source path must end with a file or directory name"
end

local dst_path, path_err = file.path.add_component(dst_dir, name)
if not dst_path then
return false, path_err
end
return file.move(src_path, dst_path, mode)
end

-- Supposons que /d/e soit un répertoire existant ; déplacer c vers /d/e/c
local ok, err = file_move_into("/a/b/c", "/d/e/")
if not ok then
print("Échec du déplacement : "..err)
end

-- Pour remplacer /d/e/c, indiquez le mode de remplacement lors de l’appel :
-- file_move_into("/a/b/c", "/d/e/", "overwrite")

Remarque : le code ci-dessus utilise file.exists, file.path.last_component et file.path.add_component.